home *** CD-ROM | disk | FTP | other *** search
/ Complete Internet Archive / Complete Internet Archive.iso / Log Analyser / kiwt_kit.exe / DATA.Z / kiwtguid.doc (.txt) < prev    next >
Word Document  |  1997-01-07  |  50KB  |  244 lines
  1.  
  2. Know-ItΓäó WebTrakΓäó  v1.2 Guide
  3.  
  4. Introduction
  5.  
  6. WebTrak provides basic HTTPD log analysis and reporting.  WebTrak reads any
  7. given CERN formatted log ( Common Log File Format (NCSA))  from a text file
  8. and produces a report in HTML format suitable for viewing with your Web
  9. browser. WebTrak produces statistical report and bar graphs in HTML.
  10.  
  11. FEATURES:
  12. 1) Reads CERN formatted HTTPD log files.
  13. 2) Produces HTML formatted reports and graphs for:
  14.             . Top Users
  15.             . Activity by Date
  16.             . Top  Pages accessed
  17.             . Top Directories accessed
  18.             . Activity by nation
  19.             . Hourly Activity Report
  20.  
  21. 3) Reports include numeric and graphical (bar chart)
  22. representation.
  23. 4) Easy to install and use, WebTrak is made to be run in
  24. batch mode with parameters defined in a easy to edit text file.
  25.  5) Administrators my specify up 100 address exclusions,
  26. including 'wildcard' specifications, Input file name, output file
  27. name, file type exclusions, and may specify whether to perform
  28. IP address/name conversion or not.   Administrators may also exclude
  29. file types (.gif, .jpg, etc..) from the Top Page report.
  30. 6) IP address/name conversions are cached thereby decreasing
  31. reporting time required.  This cache is saved in a file which is
  32. preloaded for the next reporting run, so subsequent report production times
  33. are dramatically decreased.
  34. Section 1 - Installation and Setup
  35.  
  36.       There are seven steps to successfully setting up a reporting system
  37. using the WebTrak software.  These steps are:
  38.  
  39. 1) Install WebTrak Kit.
  40. 2) Edit the WebTrak parameters file.
  41. 3) Setup the WebTrak executable to run manually or automatically.
  42.  
  43.  
  44. Step 1 - Install WebTrak kit:
  45.  
  46.       Initially download the latest version of the WebTrak installation kit
  47. from the Know-It Internet Web site.  The kit should be called
  48. 'KIWT_KIT.EXE' and is a self-installing archive.  Execute the kit file
  49. start the installation process.  You can execute the kit file by typing
  50. it's name in the command line of a DOS window, or double-clicking it from
  51. the file-manager, or using the RUN option from the file-manager or
  52. Explorer.
  53.  
  54.       Before running KIWT_KIT.EXE, exit any programs that may interfere
  55. with the installation of this product.  Upon executing KIWT_KIT.EXE, you
  56. will need to provide the following information to the screens when
  57. prompted:
  58.  
  59.       A target directory for placing the executable files.  A separate
  60. directory just for the WebTrak executables may be created if desired, but
  61. is not necessary, as WebTrak contains a complete uninstall utility should
  62. the need ever arise to remove the WebTrak system.  There is one 32 bit
  63. executable program and a parameter file (WTPARAM.DAT) that are placed in
  64. this directory.  After the initial run of the WebTrak program, a third file
  65. will be created which is called WTIPNAME.DAT which serves as the IP address-
  66. to-name cache file between runs.
  67.  
  68.  
  69.       A target directory for placing the provided HTML file.    The WebTrak
  70.       kit    provides a single file called HSTB.GIF which is required to be
  71.       accessible to the browser that is used to view the HTML output report
  72.       file.  The report file assumes that the .GIF file is available at the
  73.       top level of the server.
  74.  
  75.  
  76.  
  77. After entering the appropriate information, the files are copied from the
  78. kit to the target directories.
  79.  
  80.  
  81. STEP 2 - Editing the parameter file:
  82.  
  83.       The parameter file (WTPARAM.DAT) may be easily edited to adjust the
  84. report requirements as desired.  Parameters are set using commands placed
  85. on individual lines in the file.  The file can be edited with any text
  86. editor, but must be saved as a text file (i.e. not in a word processor
  87. format). When editing the file, lines beginning with ';' (or blank lines),
  88. are comments.
  89.  
  90. Commands are:
  91.  
  92.             EXCLUDE_ADDR     - (any part of an IP address(es) to skip
  93.                        example: 123.123.123 will skip all log records that
  94. have
  95.                        an IP address beginning with 123.123.123
  96.                        (such as 123.123.123.7).  If your server pre-
  97. translates
  98.                        addresses, so that you have names instead of numbers
  99.                        in your log file, you can enter names to exclude
  100. also.
  101.                        (such as FRED.ABC.COM).
  102. LOOKUP      - (Y or N) turns on or off IP address to name lookup
  103.                        (if you don't care about the names, reporting is
  104. faster off)
  105.                        You can also set the flag to ΓÇÿXΓÇÖ which means only
  106. use the
  107.                        existing IP name table (no new lookups).  This is
  108. useful if
  109.                        you want to rerun a report quickly.  The default is
  110. ΓÇÿYΓÇÖ.
  111.       INFILE     - designate the log file to be read. If not present
  112. program
  113.                        will ask at runtime.
  114.       OUTFILE    - designate the HTML file to be created. If not present
  115.                        program will ask at runtime.
  116.       DEBUG      - 'N'(default), 'Y' show IP address lookup activity
  117.       TITLE      - The title you want placed at the top of the report
  118.       LICENSE    - The license for your site.  If not valid, will only
  119.                        process 1000 log records - good for testing.  A
  120. license
  121.                        should be obtained from Know-It.
  122.       TIMEOUT    - Number of seconds to perform a DNS lookup of an IP
  123. address
  124.                        if LOOKUP is on.
  125.       EXCLUDE_TYPE - Exclude certain file types from the top page report.
  126. Typical
  127.                        files to exclude are .gif, .jpg, etc..   Be sure to
  128. include the
  129.                        dot (ΓÇÿ.ΓÇÖ).
  130.       HOFFSET    - Allows designation of an offset amount from the time in
  131. the log
  132.                        file to the actual local time.  Value may be
  133. positive or
  134.                        negative.
  135.       NOSHOW     - No parameters required.  This turns off the report at
  136. the end of
  137.                        input parameters if desired.
  138.       MAXUSERS - Designate the size of the Top Users report. (10 - 9999)
  139.       MAXPAGES - Designate the size of the Top Pages report. (10 - 9999)
  140.       MAXDIRS - Designate the size of the Top Directoriess report. (10 -
  141. 500)
  142.       MAXNATIONS - Designate the size of the Top Nations report. (10 - 500)
  143.       ADJWIDTH    -  Adjust width of bar graphs relative size.  Width
  144. Factor starts at
  145. You can use this parameter to adjust the size by
  146. setting it from -350 to 350.   Using the line
  147. ADJWIDTH=-100 for example would decrease the width of
  148. the bar graphs by about 25 %.  (thatΓÇÖs a minus 100).
  149.       ROBOTS=RPT - causes the Top Users report to indicate if a user is a
  150. Web Spider.
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.       Here is an example file:
  158. EXCLUDE_ADDR=123.456
  159. LICENSE=0000000000
  160. INFILE=C:\HTTPD\LOGS\ACCESS.LOG
  161. OUTFILE=C:\HTTPD\HTML\WEB_RPT.HTM
  162. TITLE=My CompanyΓÇÖs WebTrak Report
  163. TIMEOUT=15
  164. EXCLUDE_TYPE=.gif
  165. HOFFSET=-5
  166. NOSHOW
  167. LOOKUP=Y
  168. MAXUSERS=30
  169. ROBOTS=RPT
  170.  
  171.  
  172. STEP 3 - Setup to run manually or automatically:
  173.  
  174.       Produce a report by running the program, the KIWT.EXE .  This can be
  175. accomplished by executing the KIWT.EXE file, that is typing it's name in
  176. the command line of a DOS window, or double-clicking it from the file-
  177. manager, or using the RUN option from the file-manager or Explorer.  It is
  178. likely that this process will be automated by having the program invoked
  179. using a scheduling tool such as AT under Windows NT, or the System Agent
  180. under Windows95.  No parameters need be given to
  181. the program at runtime since all can be defined in the parameters file.
  182. However, if the input file or output file are not designated in the
  183. parameters file, they will be asked for
  184. at runtime.
  185.  
  186. NOTE:  The first time the program is run, if the input log file is large
  187. and contains many diverse IP addresses, it will take quite awhile to
  188. complete due to the time required to lookup each new IP address.  These
  189. ΓÇÿname serverΓÇÖ lookups will be saved for subsequent runs, and only
  190. incrementally new addresses requested from the name server.  Typically, new
  191. addresses represent only a small percentage of subsequent runs.  To produce
  192. quicker results, the LOOKUP option may be turned off  (see STEP 2 above) if
  193. the name of the sites is not required.
  194.  
  195.  
  196.  
  197.  
  198.  
  199. Section II - Maintenance
  200.  
  201.       No maintenance is required by the WebTrak software.  The WTIPNAME.DAT
  202. file may be edited if desired to delete entries for addresses that have
  203. changed, or if the editor wishes to change the name reported for a
  204. particular address.  It might be desired for example to change an machine
  205. name (such as  machine12.company.com) to a particular userΓÇÖs name  (such as
  206. John Smith). The file can be edited with any text editor, but must be saved
  207. as a text file (i.e. not in a word processor format), and the format of the
  208. file (comma delimited) should be maintained.
  209.  
  210.       Additional features are planned for version 2.0 of WebTrak including
  211. file type exclusion, and additional reports and graphs.  Also the ability
  212. to switch off and on certain reports will be available.  If you desire
  213. these options or others please send an Email to KI_TEAM@KNOW-IT.COM  with
  214. the details of your request.  Please also state if you would be willing to
  215. be a beta site for an upcoming release.
  216.  
  217.  
  218. Ordering Information:
  219.  
  220. To receive a registration key for WebTrak, please send the network name of
  221. the system on which you will be running WebTrak, plus the registration fee
  222. ($49 commercial, $39 non-profit groups  (in US$ via check or money order) *
  223. ), to
  224.  
  225.       Know-It / WebTrak Registration
  226.       14651 Dallas Parkway
  227.       Suite 404
  228.       Addison, TX  75240
  229.  
  230.       Upon receipt, we will return your registration key which you can
  231. enter into the WTPARAMS.DAT file to allow processing of unlimited records.
  232. The network name of your system, can be observed in the first few lines of
  233. the screen output of WebTrak when it is invoked.  The line says "running
  234. on:" and the the network name of your system.  For a WindowsNT system, it
  235. is usually one word (e.g. 'myserver'), but for a Windows95 system, it is
  236. the complete network name (e.g. 'myserver.xyz.com').
  237.  
  238. * Always check the Know-It Web Site for the latest information, prices and
  239. releases at:
  240.  
  241.       http://know-it.com
  242.  
  243.  
  244.